You can access the Business Tasks form from the Edit Business Tasks button in the Tran Type form, Trk Visit form, Appt Tran Type form, Trk Vst Appt form, Pre-advise Tran Type form, and IFT Tran Type form
Business tasks are pieces of business logic that you can use to customize your gate processing. There are many business tasks that cover a wide range of functionality, including adding the ability to create new data for a gate transaction or truck visit, reject a gate transaction per the business rules required, and print gate documents for a gate transaction. For a full list of business tasks, see Business Tasks in N4 (on page 1).
The Business Tasks form displays the available business tasks for the selected entity, such as a gate transaction type, a truck visit, or an appointment gate stage, that you are configuring. The timing and order in which N4 executes an included business task depends on the entity:
For gate transactions, such as Receive Export or Receive Empty, N4 processes tasks when you click the Save Transaction button on the gate transaction section of the <GateStage> tab (on page 1).
For truck visits, N4 processes business tasks according to the value of the Timing column in the Business Tasks form. The Timing column can have any of the following values:
pre-stage: The business task is processed when the truck arrives at a gate stage and validates whether the truck is at the correct gate stage.
N4 processes this business task when creating a truck visit or when you click the Save Transaction button on the <GateStage> tab for the first gate transaction.
If any pre-stage business task fails at the first gate stage, N4 does not create a truck visit, and does not allow the user to send the truck to Trouble.
on-arrival: The business task is processed when the truck arrives at the Exchange area. N4 processes this task when you click on the Confirm Arrival button at the bottom of the <GateStage> tab or process the notify-arrival API.
The Confirm Arrival button is available only if you have included an on-arrival business task in your truck visit configuration and the Stage Type of the gate stage is Out-gate Stage. Clicking this button also triggers the EC event TV_ITZ_LANE_ARRIVAL.
on-submit: The business task is executed after all the gate transactions are successfully saved for a gate stage. If the Check if All Done check box is selected for a gate stage, the on-submit business tasks are executed as soon as the gate clerk successfully saves the last gate transaction for that stage for the truck visit. If the Check If All Done check box is not selected for a gate stage, the on-submit business tasks are executed when the gate clerk clicks the Proceed to Next Stage button in the <GateStage> tab. For APIs it is when you execute the process-truck API or the stage-done API if the stage-done API is not executed from the process-truck API (do-stage-done is set to false).
validation: The business task is executed when a truck visit is created after successful execution of the pre-stage business tasks, but before the execution of the on-submit business tasks.
If a validation business task fails, N4 creates the truck visit and allows the user to send the truck visit to Trouble to be resolved later.
on-trouble: The business task is executed when the truck is sent to Trouble.
area-done: The business task is executed when N4 determines that all the gate transactions for the truck visit that were for this exchange area are done at the yard stage.
This gate work flow is executed when either of the following conditions is true:
N4 receives an area-done message through the API.
A clerk successfully Saves the last gate transaction for the yard stage at this exchange area and before the clerk clicks the Proceed to Next Stage button for the truck from a gate form.
As the final step in a process-truck API message when all transactions have been submitted.
Automatically from the transaction-level on-submit workflow if the stage is configured to check if all transactions are submitted for that stage. If the transaction-level on-submit workflow passes successfully, N4 checks whether this is the last transaction to be submitted during this visit to an exchange area, meaning that the next transaction, which has not yet been submitted at this stage, is for a different exchange area. If this is the last transaction submitted at the stage, then N4 considers it the last transaction at the exchange area. If the exchange area is null, either because it is a non-exchange area move in a terminal that has exchange areas or the terminal has no exchange areas, then null is treated like any other individual exchange area value.
For appointments, N4 processes business tasks on two occasions:
If the business task is included in the Include column, N4 processes it when you click Save in the Appointment form (on page 1).
If the business task is included in the Include Dispatch column, N4 processes it when you click Save after associating the appointment with a truck visit appointment.
For truck visit appointments, N4 processes the business tasks when you click Save in the Truck Visit Appointment form (on page 1).
For pre-advise vessel or rail, N4 processes the business tasks when you click the Save Transaction button on the <Pre-advise> tab (on page 1).
To configure if and how the gate uses bookings or ad hoc bookings, see the Booking Rules tab in the Line Operator form.
Use the Actions menu to configure the business tasks (on page 1) for the selected transaction.
To help find the business task you are looking for, you can sort the business tasks by clicking on any column in the Business Tasks form.
N4 executes each included business task in the order in which it appears in the Business Tasks form when you first open the form. If you sort by any of the columns in the Business Tasks form, then you must close the Business Tasks and parent form, such as the Tran Type form, and reopen these forms to see the order in which the business tasks are executed.
For a complete list of business tasks, see Business Tasks in N4.